Update variable replacement during deserialization to use replacement settings class and add AKV replacement logic. #2882
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RubenCerna2079
requested changes
Oct 7, 2025
Contributor
RubenCerna2079
left a comment
RubenCerna2079
left a comment
There was a problem hiding this comment.
Still need to get rid of envVar in some places and resolve missing logic inside of an if statement.
Aniruddh25
requested changes
Oct 30, 2025
Collaborator
Aniruddh25
left a comment
Aniruddh25
left a comment
There was a problem hiding this comment.
The changes look good to me. This is a good refactor. However, unit testing still remains and so does the test in AKV environment.
src/Service.Tests/UnitTests/RuntimeConfigLoaderJsonDeserializerTests.cs
Outdated
Show resolved
Hide resolved
Aniruddh25
reviewed
Oct 31, 2025
Aniruddh25
reviewed
Oct 31, 2025
Aniruddh25
reviewed
Oct 31, 2025
src/Service.Tests/UnitTests/PostgreSqlQueryExecutorUnitTests.cs
Outdated
Show resolved
Hide resolved
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Aniruddh25
reviewed
Nov 6, 2025
Aniruddh25
reviewed
Nov 7, 2025
src/Service.Tests/UnitTests/RuntimeConfigLoaderJsonDeserializerTests.cs
Outdated
Show resolved
Hide resolved
Aniruddh25
reviewed
Nov 7, 2025
Aniruddh25
reviewed
Nov 7, 2025
Aniruddh25
reviewed
Nov 7, 2025
Aniruddh25
reviewed
Nov 7, 2025
|
|
||
| private static SecretClient CreateSecretClient(AzureKeyVaultOptions options) | ||
| { | ||
| if (string.IsNullOrWhiteSpace(options.Endpoint)) |
Collaborator
There was a problem hiding this comment.
Need to test if child configs do infact inherit the akv endpoint values from the parent config - see the multiple configs section of the enhancement.
Aniruddh25
reviewed
Nov 7, 2025
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
…a-api-builder into dev/aaronburtle/AKVReplacement
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
…a-api-builder into dev/aaronburtle/AKVReplacement
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Aniruddh25
reviewed
Nov 14, 2025
| // ie: @env('hello@env('goodbye')world') match: 'hello@env('goodbye')world' | ||
| public const string INNER_ENV_PATTERN = @"[^@env\(].*(?=\))"; | ||
| public const string INNER_AKV_PATTERN = @"[^@AKV\(].*(?=\))"; | ||
| public const string INNER_AKV_PATTERN = @"[^@akv\(].*(?=\))"; // changed from [^@AKV\(] |
Collaborator
There was a problem hiding this comment.
Suggested change
| public const string INNER_AKV_PATTERN = @"[^@akv\(].*(?=\))"; // changed from [^@AKV\(] | |
| public const string INNER_AKV_PATTERN = @"[^@akv\(].*(?=\))"; |
Aniruddh25
reviewed
Nov 14, 2025
| // Note that there is no escape character currently for ')' to exist within the name of the variable. | ||
| public const string OUTER_ENV_PATTERN = @"@env\('.*?(?='\))'\)"; | ||
| public const string OUTER_AKV_PATTERN = @"@AKV\('.*?(?='\))'\)"; | ||
| public const string OUTER_AKV_PATTERN = @"@akv\('.*?(?='\))'\)"; // changed from @AKV to @akv |
Collaborator
There was a problem hiding this comment.
Suggested change
| public const string OUTER_AKV_PATTERN = @"@akv\('.*?(?='\))'\)"; // changed from @AKV to @akv | |
| public const string OUTER_AKV_PATTERN = @"@akv\('.*?(?='\))'\)"; |
seems like copilot made those changes and left comments in your code, which should have been cleaned up before publishing for PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why make this change?
Adds AKV variable replacement and expands our design for doing variable replacements to be more extensible when new variable replacement logic is added.
Closes #2708
Closes #2748
Related to #2863
What is this change?
Change the way that variable replacement is handled to instead of simply using a
boolto indicate that we want env variable replacement, we add a class which holds all of the replacement settings. This will hold whether or not we will do replacement for each kind of variable that we will handle replacement for during deserialization. We also include the replacement failure mode, and put the logic for handling the replacements into a strategy dictionary which pairs the replacement variable type with the strategy for doing that replacement.Because Azure Key Vault secret replacement requires having the retry and connection settings in order to do the AKV replacement, we must do a first pass where we only do non-AKV replacement and get the required settings so that if AKV replacement is used we have the required settings to do that replacement.
We also have to keep in mind that the legacy of the
Configuration Controllerwill ignore all variable replacement, so we construct the replacement settings for this code path to not use any variable replacement at all.How was this tested?
We have updated the logic for the tests to use the new system, however manual testing using an actual AKV is still required.
Sample Request(s)